/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.netbeans.modules.profiler.v2;

import javax.swing.JMenu;
import org.openide.util.Lookup;

/**
 * Common superclass for simple addons integrating into the Profile menu and
 * getting notifications about state of the profiler session.
 *
 * @author Jiri Sedlacek
 */
public abstract class ProfilerPlugin {
    
    private final String name;
    
    
    public ProfilerPlugin(String name) {
        if (name == null) throw new IllegalArgumentException("Plugin name cannot be null"); // NOI18N
        this.name = name;
    }
    
    
    public final String getName() {
        return name;
    }
    
    
    public abstract void createMenu(JMenu menu);
    
    
    protected void sessionStarting() {}
    
    protected void sessionStarted()  {}
    
    protected void sessionStopping() {}
    
    protected void sessionStopped()  {}
    
    
    // --- Provider ------------------------------------------------------------
    
    public abstract static class Provider {
        
        public abstract ProfilerPlugin createPlugin(Lookup.Provider project, SessionStorage storage);
        
    }
    
}
